home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Tools / Languages / Python 1.1 / README < prev    next >
Encoding:
Text File  |  1994-10-11  |  18.2 KB  |  405 lines  |  [TEXT/R*ch]
  1. Python release 1.1
  2. ==================
  3.  
  4. ==> This is Python version 1.1.  
  5.  
  6. ==> Python 1.1 contains many improvements over 1.0.3, but is almost
  7.     backward compatible (though the magic number for .pyc file has
  8.     changed).  It is portable to many more non-UNIX platforms.
  9.  
  10. ==> If you don't know yet what Python is: it's an interpreted,
  11.     extensible, embeddable, interactive, object-oriented programming
  12.     language.  For a quick summary of what Python can mean for a
  13.     UNIX/C programmer, read Misc/BLURB.LUTZ.
  14.  
  15. ==> If you want to start compiling right away (on UNIX): just type
  16.     "./configure" in the current directory and when it finishes, type
  17.     "make".  See the section Build Instructions below for more
  18.     details.
  19.  
  20. ==> All documentation is in the subdirectory Doc in the form of LaTeX
  21.     files.  In order of importance for new users: Tutorial (tut),
  22.     Library Reference (lib), Language Reference (ref), Extending
  23.     (ext).  Note that especially the Library Reference is of immense
  24.     value since much of Python's power (including the built-in data
  25.     types and functions!) is described there.  [NB The ext document
  26.     has not been updated to reflect this release yet.]
  27.  
  28. ==> Python is COPYRIGHTED but free to use for all.  See the copyright
  29.     notice at the end of this file.  Moreover, the Python distribution
  30.     is not affected by the GNU Public Licence (GPL).  There is support
  31.     for interfaces to some GNU code but this is entirely optional and
  32.     no GNU code is distributed with Python.  For all these packages,
  33.     GPL-free public domain versions also exist.
  34.  
  35.  
  36. Build instructions
  37. ------------------
  38.  
  39. Before you start building Python, you must first configure it.  This
  40. entails (at least) running the script "./configure", which figures out
  41. your system configuration and creates several Makefiles.  (This will
  42. take a minute or two -- please be patient!)  When it is done, you are
  43. ready to run make.  Typing "make" in the toplevel directory will
  44. recursively run make in each of the subdirectories Parser, Objects,
  45. Python and Modules, creating a library file in each one.  The
  46. executable of the interpreter is built in the Modules subdirectory but
  47. moved up here when it is built.  If you want or need to, you can also
  48. chdir into each subdirectory in turn and run make there manually
  49. (do the Modules subdirectory last!).  If you run into trouble, first
  50. see the section Troubleshooting later in this file.
  51.  
  52. EXCEPTIONS: on SVR4 derived systems, you need to pass the configure
  53. script the option --with-svr4.  See below for more options you can
  54. pass to the configure script.
  55.  
  56. AIX users: read the file Misc/AIX-NOTES before trying to build.
  57.  
  58. HP-UX users: read the file Misc/HPUX-NOTES if you want to be able to
  59. use shared libraries for dynamically loaded modules.
  60.  
  61. Minix users: when using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
  62.  
  63. You can configure the interpreter to contain fewer or more built-in
  64. modules by editing the file Modules/Setup.  This file is initially
  65. copied (when the toplevel Makefile makes Modules/Makefile for the
  66. first time) from Setup.in; if it does not exist yet, make a copy
  67. yourself.  Never edit Setup.in -- always edit Setup.  Read the
  68. comments in the file for information on what kind of edits you can
  69. make.  When you have edited Setup, Makefile and config.c in Modules
  70. will automatically be rebuilt the next time you run make in the
  71. toplevel directory.  (There are some example Setup files which you may
  72. copy to Setup for specific systems; have a look at Setup.*.)
  73.  
  74. If you want to change the optimization level of the build, assign to
  75. the OPT variable on the toplevel make command; e.g. "make OPT=-g" will
  76. build a debugging version of Python on most platforms.  The default is
  77. OPT=-O; a value for OPT in the environment when the configure script
  78. is run overrides this default (likewise for CC; and the initial value
  79. for LIBS is used as the base set of libraries to link with).
  80.  
  81. To test the interpreter that you have just built, type "make test".
  82. This runs the test set silently, twice (once with no compiled files,
  83. once with the compiled files left by the previous test run).  Each
  84. test run should print "All tests OK." and nothing more.  (The test set
  85. does not test the built-in modules, but will find most other problems
  86. with the interpreter.)
  87.  
  88. To install the interpreter as /usr/local/bin/python, type "make
  89. install".  To install the library as /usr/local/lib/python, type "make
  90. libinstall".  To install the manual page as
  91. /usr/local/man/man1/python.1, type "make maninstall".  To install the
  92. Emacs editing mode for python, manually copy the file
  93. Misc/python-mode.el to your local Emacs lisp directory.  The directory
  94. /usr/local can be overridden at configuration time by passing
  95. --prefix=DIRECTORY to the configure script, or at make time by passing
  96. "prefix=DIRECTORY" to make.  See below for more information on --prefix.
  97.  
  98. If you plan to do development of extension modules or to embed Python
  99. in another application and don't want to reference the original source
  100. tree, you can type "make inclinstall" and "make libainstall" to
  101. install the include files and lib*.a files, respectively, as
  102. /usr/local/include/Py/*.h and /usr/local/lib/python/lib/lib*.a.  The
  103. make libainstall target also installs copies of several other files
  104. used or produced during the build process which are needed to build
  105. extensions or to generate their Makefiles.
  106.  
  107. To print the documentation, cd into the Doc subdirectory, type "make"
  108. (let's hope you have LaTeX installed!), and send the four resulting
  109. PostScript files (tut.ps, lib.ps, ref.ps, and ext.ps) to the printer.
  110. See the README file there; you can also build a texinfo version of the
  111. library manual and from that construct an Emacs info version (the
  112. hypertext format used by the Emacs "info" command) and an HTML version
  113. (the hypertext format used by the World Wide Web distributed
  114. information initiative).  You don't need to have LaTeX installed for
  115. this.  Note that the Python archive sites also carry the resulting
  116. PostScript files, in case you have a PostScript printer but not LaTeX.
  117.  
  118. Some special cases are handled by passing environment variables or
  119. options to the configure script:
  120.  
  121. - The configure script uses gcc (the GNU C compiler) if it finds it.
  122. If you don't want this, or if this compiler is installed but broken on
  123. your platform, pass "CC=cc" (or whatever the name of the proper C
  124. compiler is) in the environment.
  125.  
  126. - On System V, Release 4 derived systems (e.g. SOLARIS 2, but not
  127. IRIX 5) you need to call the configure script with the option
  128. --with-svr4.  This is needed so the libraries -lnsl and -lsocket are
  129. found.  (On some other systems, e.g. IRIX 5, these libraries exist but
  130. are incompatible with other system libraries such as X11 and GL.)
  131.  
  132. - If you want to install the binaries and the Python library somewhere
  133. else than in /usr/local/{bin,lib}, you can pass the option
  134. --prefix=DIRECTORY; the interpreter binary will be installed as
  135. DIRECTORY/bin/python and the library files as DIRECTORY/lib/python/*.
  136. If you pass --exec-prefix=DIRECTORY (as well) this overrides the
  137. installation prefix for architecture-dependent files (like the
  138. interpreter binary).  Note that --prefix=DIRECTORY also affects the
  139. default module search path (sys.path), when Modules/config.c is
  140. compiled.  Passing make the option prefix=DIRECTORY (and/or
  141. exec_prefix=DIRECTORY) overrides the prefix set at configuration time;
  142. this may be more convenient than re-running the configure script if
  143. you change your mind about the install prefix...
  144.  
  145. - You can use the GNU readline library to improve the interactive user
  146. interface: this gives you line editing and command history when
  147. calling python interactively.  You need to configure build the GNU
  148. readline library before running the configure script.  Its sources are
  149. not distributed with Python; you can ftp them from any GNU mirror
  150. site, or from its home site:
  151. ftp://slc2.ins.cwru.edu/pub/dist/readline-2.0.tar.gz (or a higher
  152. version number -- using version 1.x is not recommended).
  153.  
  154. A GPL-free version was posted to comp.sources.misc in volume 31 and is
  155. widely available from FTP archive sites.  One URL for it is:
  156. ftp://gatekeeper.dec.com/.b/usenet/comp.sources.misc/volume31/editline/part01.Z
  157.  
  158. Pass the Python configure script the option --with-readline=DIRECTORY
  159. where DIRECTORY is the absolute pathname of the directory where you've
  160. built the readline library.  Some hints on building and using the
  161. readline library:
  162.  
  163.     - On SGI IRIX 5, you may have to add the following
  164.     to rldefs.h:
  165.  
  166.     #ifndef sigmask
  167.     #define sigmask(sig)    (1L << ((sig)-1))
  168.     #endif
  169.  
  170.     - On most systems, you will have to add #include "rldefs.h" to the
  171.     top of several source files, and if you use the VPATH feature, you
  172.     will have to add dependencies of the form foo.o: foo.c to the
  173.     Makefile for several values of foo.
  174.  
  175.     - The readline library requires use of the termcap library.  A
  176.     known problem with this is that it contains entry points which
  177.     cause conflicts with the STDWIN and SGI GL libraries.  The stdwin
  178.     conflict can be solved (and will be, in the next release of
  179.     stdwin) by adding a line saying '#define werase w_erase' to the
  180.     stdwin.h file (in the stdwin distribution, subdirectory H).  The
  181.     GL conflict has been solved in the Python configure script by a
  182.     hack that forces use of the static version of the termcap library.
  183.  
  184.     - Check the newsgroup gnu.bash.bugs for specific problems with the
  185.     readline library (I don't get this group here but I've been told
  186.     that it is the place for readline bugs.)
  187.  
  188. - On SGI IRIX, and on Sun SOLARIS 2, you can use multiple threads.  To
  189. enable this, pass --with-thread.  In the Modules/Setup file, enable
  190. the thread module.  (Threads aren't enabled automatically because
  191. there are run-time penalties when support for them is compiled in even
  192. if you don't use them.)
  193.  
  194. - On SGI IRIX, there are modules that interface to many SGI specific
  195. system libraries, e.g. the GL library and the audio hardware.  To
  196. enable these modules, you must edit the Modules/Setup file (or copy the
  197. Setup.irix4 file to it).
  198.  
  199. - On SGI IRIX 4, dynamic loading of extension modules is supported by
  200. the "dl" library by Jack Jansen, which is ftp'able from
  201. ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.  This is enabled (after
  202. you've ftp'ed and compiled the dl library!) by passing
  203. --with-sgi-dl=DIRECTORY where DIRECTORY is the absolute pathname of
  204. the dl library.  (Don't bother on IRIX 5, it already has dynamic
  205. linking using SunOS style shared libraries.)  Support for this feature
  206. is deprecated.
  207.  
  208. - Dynamic loading of modules is rumoured to be supported on some other
  209. systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent Symmetry (Dynix), and
  210. Atari ST.  This is done using a combination of the GNU dynamic loading
  211. package (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
  212. emulation of the SGI dl library mentioned above (the emulation can be
  213. found at ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z).  To enable
  214. this, ftp and compile both libraries, then call the configure passing
  215. it the option --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where
  216. DL_DIRECTORY is the absolute pathname of the dl emulation library and
  217. DLD_DIRECTORY is the absolute pathname of the GNU dld library.  (Don't
  218. bother on SunOS 4 or 5, they already have dynamic linking using shared
  219. libraries.)  Support for this feature is deprecated.
  220.  
  221. - It is possible to specify alternative versions for the Math library
  222. (default -lm) and the C library (default the empty string) using the
  223. options --with-libm=STRING and --with-libc=STRING, respectively.  E.g.
  224. if your system requires that you pass -lc_s to the C compiler to use
  225. the shared C library, you can pass --with-libc=-lc_s.  These libraries
  226. are passed after all other libraries, the C library last.
  227.  
  228. You can also build an "extended" interpreter, using modules that are
  229. not contained in the Modules directory.  Extensions are distributed as
  230. a separate tar file (currently extensions.tar.Z).  See the README file
  231. there.
  232.  
  233.  
  234. Building for multiple architectures (using the VPATH feature)
  235. -------------------------------------------------------------
  236.  
  237. If your file system is shared between multiple architectures, it
  238. usually is not necessary to make copies of the sources for each
  239. architecture you want to support.  If the make program supports the
  240. VPATH feature, you can create an empty build directory for each
  241. architecture, and in each directory run the configure script (on the
  242. appropriate machine with the appropriate options).  This creates the
  243. necessary subdirectories and the Makefiles therein.  The Makefiles
  244. contain a line VPATH=... which points to directory containing the
  245. actual sources.  (On SGI systems, use "smake" instead of "make" if you
  246. use VPATH -- don't try gnumake.)
  247.  
  248. For example, the following is all you need to build a minimal Python
  249. in /usr/tmp/python (assuming ~guido/src/python is the toplevel
  250. directory and you want to build in /usr/tmp/python):
  251.  
  252.     $ mkdir /usr/tmp/python
  253.     $ cd /usr/tmp/python
  254.     $ ~guido/src/python/configure
  255.     [...]
  256.     $ make
  257.     [...]
  258.     $
  259.  
  260. Note that Modules/Makefile copies the original Setup file to the build
  261. directory if it finds no Setup file there.  This means that you can
  262. edit the Setup file for each architecture independently.  For this
  263. reason, subsequent changes to the original Setup file are not tracked
  264. automatically, as they might overwrite local changes.  To force a copy
  265. of a changed original Setup file, delete the target Setup file.  (The
  266. makesetup script supports multiple input files, so if you want to be
  267. fancy you can change the rules to create an empty Setup.local if it
  268. doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
  269. however this assumes that you only need to add modules.)
  270.  
  271.  
  272. Troubleshooting
  273. ---------------
  274.  
  275. See section 3 of the FAQ (in subdirectory Misc of the distribution)
  276. for hints on what can go wrong, and how to fix it.
  277.  
  278.  
  279. Building on non-UNIX systems
  280. ----------------------------
  281.  
  282. On non-UNIX systems, you will have to fake the effect of running the
  283. configure script manually.  A good start is to copy the file
  284. config.h.in to config.h and edit the latter to reflect the actual
  285. configuration of your system.  Most symbols must simply be defined as
  286. 1 only if the corresponding feature is present and can be left alone
  287. otherwise; however RETSIGTYPE must always be defined, either as int or
  288. as void, and the *_t type symbols must be defined as some variant of
  289. int if they need to be defined at all. Then arrange that the symbol
  290. HAVE_CONFIG_H is defined during compilation (usually by passing an
  291. argument of the form `-DHAVE_CONFIG_H' to the compiler, but this is
  292. necessarily system-dependent).
  293.  
  294. I have tried to collect instructions, Makefiles and additional sources
  295. for various platforms in this release.  The following directories
  296. exist:
  297.  
  298. Mac/        Apple Macintosh, using THINK C 6.0 or MPW 3.2.
  299. Dos/        MS-DOS and Windows 3.1, using Microsoft C.
  300. Nt/        Windows NT, using Microsoft Visual C/C++.
  301. Os2/        OS/2.
  302.  
  303. Most of these instructions were last tested with a previous Python
  304. release, so you may still experience occasional problems.  If you have
  305. fixes or suggestions, please let me know and I'll try to incorporate
  306. them in the next release.
  307.  
  308.  
  309. Distribution structure
  310. ----------------------
  311.  
  312. Most subdirectories have their own README file.  Most files have
  313. comments.
  314.  
  315. ChangeLog    A raw list of changes since the first 1.0.0 BETA release
  316. Demo/        Demonstration scripts, modules and programs
  317. Doc/        Documentation (in LaTeX)
  318. Extensions/    Extension modules (distributed separately)
  319. Grammar/    Input for the parser generator
  320. Include/    Public header files
  321. Lib/        Python library modules
  322. Makefile    Rules for building the distribution
  323. Misc/        Miscellaneous files
  324. Modules/    Implementation of most built-in modules
  325. Objects/    Implementation of most built-in object types
  326. Parser/        The parser and tokenizer and their input handling
  327. Python/        The "compiler" and interpreter
  328. README        The file you're reading now
  329. acconfig.h    Additional input for the autoheader program
  330. config.h    Configuration header (generated)
  331. config.h.in    Source from which config.status creates config.h
  332. config.status    status from last run of configure script (generated)
  333. configure    Configuration shell script (GNU autoconf output)
  334. configure.in    Configuration specification (GNU autoconf input)
  335. tags, TAGS    Tags files for vi and Emacs (generated)
  336. python        The executable interpreter (generated)
  337.  
  338.  
  339. Ftp access
  340. ----------
  341.  
  342. The latest Python source distribution can be ftp'ed from
  343. ftp://ftp.cwi.nl/pub/python/python<version>.tar.gz.  You can also find
  344. PostScript of the main Python documentation there, Macintosh and PC
  345. binaries, and the latest STDWIN source distribution (in directory
  346. /pub/stdwin).  oFr mirror sites, see the list in the FAQ (Misc/FAQ
  347. this directory).
  348.  
  349.  
  350. Mailing list and Newsgroup
  351. --------------------------
  352.  
  353. There are a mailing list and a newsgroup devoted to Python
  354. programming, design and bugs.  The newsgroup, comp.lang.python,
  355. contains exactly the same messages as the mailing list.  To subscribe
  356. to the mailing list, send mail containing your real name and e-mail
  357. address in Internet form to "python-list-request@cwi.nl".
  358.  
  359.  
  360. Author
  361. ------
  362.  
  363. Guido van Rossum
  364. CWI, dept. CST
  365. P.O. Box 94079
  366. 1090 GB  Amsterdam
  367. The Netherlands
  368.  
  369. E-mail: Guido.van.Rossum@cwi.nl
  370.  
  371.  
  372. Copyright Notice
  373. ----------------
  374.  
  375. The Python source is copyrighted, but you can freely use and copy it
  376. as long as you don't change or remove the copyright:
  377.  
  378. Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
  379. Amsterdam, The Netherlands.
  380.  
  381.                         All Rights Reserved
  382.  
  383. Permission to use, copy, modify, and distribute this software and its
  384. documentation for any purpose and without fee is hereby granted,
  385. provided that the above copyright notice appear in all copies and that
  386. both that copyright notice and this permission notice appear in
  387. supporting documentation, and that the names of Stichting Mathematisch
  388. Centrum or CWI not be used in advertising or publicity pertaining to
  389. distribution of the software without specific, written prior permission.
  390.  
  391. STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
  392. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  393. FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
  394. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  395. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  396. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  397. OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  398.  
  399.  
  400. Signature
  401. ---------
  402.  
  403. --Guido van Rossum, CWI, Amsterdam <Guido.van.Rossum@cwi.nl>
  404. <URL:http://www.cwi.nl/cwi/people/Guido.van.Rossum.html>
  405.